home *** CD-ROM | disk | FTP | other *** search
/ System Booster / System Booster.iso / Texteditors / Origami / AmigaDocs / README.AMIGA < prev    next >
Text File  |  1996-09-26  |  14KB  |  363 lines
  1. {{{  Preface
  2. Amiga 1.6.92
  3.  
  4. This is a readme file for the Amiga-Origami-Version only.  To learn
  5. more about the origami features please read the origami-manual !
  6.  
  7. Please read the bug.fixes file each time you get a new version !
  8.  
  9. Thomas Hadig
  10. }}}
  11. {{{  Disclaimer
  12. The author cannot be held liable for the  suitability or  accuracy  of
  13. this manual  and/or  the  program(s)  it  describes.   Any  damage
  14. directly  or indirectly caused by the use or misuse of  this manual
  15. and/or the  program it describes is the sole responsibility of the user
  16. her/him self.
  17. }}}
  18.  
  19. {{{  Installing Origami
  20. To install origami start the install_origami script by using commodores
  21. installer program.
  22. }}}
  23. {{{  Additional Amiga Features
  24. There are some additional features in the amiga version of the origami
  25. editor :
  26.  
  27.  {{{  Mouse
  28.  Mouse-Handling : The mouse can be used in this version by defining
  29.  it in the binding file using the command 'mouse-buttons'.
  30.  (See the doc-files in the doc directory and the amiga.keys example
  31.  file !)
  32.  }}}
  33.  {{{  Menu
  34.  Menus can be defined in the rc-file, too.
  35.  To do that you have to use the os-extensions.
  36.  
  37.  The syntax of the menu-extension is :
  38.  (os-extension ("MENU " <name of menu,name of item> ))
  39.  
  40.  example : (os-extension ("MENU " Project,Read " File ))
  41.  (see the origami manual for the definition of ocl strings !)
  42.  
  43.  This line will make a menu entry called Project (if it has not been
  44.  defined previously) and an item entry called Read File.
  45.  If this item is selected, origami will send a keysequence with the
  46.  following syntax :
  47.  $csi "G <number of the menu entry, starting with "0 (hex 0x30)>
  48.          <number of the item entry, starting with "0 (hex 0x30)>
  49.  
  50.  You have to bind the function, that shall be called to this keysequence.
  51.  If the example has been the first MENU os-extension :
  52.  (keybind read-file ( $csi "G "0 "0 ))
  53.  
  54.  See the OSamiga.awk script for an easier definition by using the AWK
  55.  language.
  56.  }}}
  57.  {{{  FileRequester
  58.  If the 'asl.library' is present, origami will use the system file
  59.  requester.
  60.  
  61.  To use the 'read-file' function within macros I had to use a complex way to
  62.  address the requesters :
  63.    - If you use 'read-file' the file-prompt will be displayed under the
  64.      status-line.
  65.    - Press ~ or ~~ or ~<directory>
  66.    - Press RETURN
  67.    - The file-requesters will come up, showing the contents of the
  68.      following directories :
  69.      if you entered  ~      the directory, where you started origami
  70.                      ~~     the directory, where the current file is in
  71.                      ~<dir> the directory named in the prompt line
  72.  To make an easy use of the requesters bind the function
  73.    {{{  function
  74.    (deffun amiga-read-file
  75.     (
  76.      read-file
  77.      "~
  78.      O_RETURN
  79.     ))
  80.    }}}
  81.  to the key  the 'read-file' function is bound to now.
  82.  
  83.  NOTE: To get protability in the rc-files, ~/<file (with rel. path)>
  84.        will be expanded to S:<file (with rel.path).
  85.        Due to the double usage of the ~-character, you have to use
  86.        whitespace to use a file-requester starting at a dir with
  87.        a pathname beginning with a / character.
  88.        Example : ~/test : will open the file S:test,
  89.              but ~ /test : will open a filerequester starting in the
  90.              directory /test relative to the current working directory, when
  91.              you started origami.
  92.  }}}
  93.  {{{  Workbench
  94.  Origami can be called from Workbench; the command line options can be
  95.  specified as TOOL_TYPES, but there may be only one option per line;
  96.  you can also multiselect additonal files, which will be edited.
  97.  If you start origami by clicking an icon with origami as default tool
  98.  the TOOL_TYPES of this file will be used as arguments.
  99.  If you multi-select files only the TOOL_TYPES of the origami icon will
  100.  be read.
  101.  }}}
  102.  {{{  Iconify
  103.  Iconify : if you press the iconify gadget in the window title,
  104.  origami will change his window position to the upper/left edge of the
  105.  screen and resize to the smallest possible size.  The window title
  106.  will show the filename.  To open the window again, click the gadget
  107.  or the close gadget.
  108.  }}}
  109.  {{{  Wildcards
  110.  Origami will recognize wildcards in the command line filenames
  111.  and edit all matching files ('next-file' command).
  112.  }}}
  113.  {{{  Protection Bits
  114.  Origami preserves the protection bits for read (r), write (w), delete (d),
  115.  executable (e), script (s) and pure (p).
  116.  Origami always deletes the archive bit.
  117.  }}}
  118.  {{{  Window
  119.  To open a window on a specific screen or with a specific size, you can
  120.  use amiga specific options (beginning with -X) :
  121.  You can use the following keywords :
  122.  AREXX[=Portname] : origami will open an arexx port (names Portname)
  123.  SCREEN[=w/h] : origami will use his own screen
  124.  WINDOW[=x/y/w/h] : origami will use a window with the width w,
  125.         the height h, the offset (x,y)
  126.  }}}
  127.  {{{  Arexx
  128.  * For more information on the arexx port read the README.AREXX doc.
  129.  }}}
  130.  {{{  Cut & Paste
  131.  Origami now uses the clipboard device for cut and paste.
  132.  
  133.  To cut press the Right Amiga key and the left mouse button to set a mark
  134.  and release the mouse button and the Right Amiga key to copy the text area
  135.  between the mark and the end position of the mouse into the clipboard
  136.  device. To abort cutting release the Right Amiga key before releasing the
  137.  mouse button. Only the screen text will be cutted, no folds will be opened.
  138.  The selected area will not be highlighted in this version.
  139.  
  140.  To paste, release the right mouse button while having the Right Amiga key
  141.  pressed.
  142.  }}}
  143.  {{{  List Seperator
  144.  Unlike the list separator in the Un*x version (:) the amiga version uses
  145.  ;, cause the : character will be used in filenames.
  146.  }}}
  147. }}}
  148. {{{  Recompiling the emacs and modeori keybinds
  149. To recompile the bindings you can use the smakefile in the bindings
  150. directory.
  151.  
  152. If you do not have smake, take the smakefile as an example for the options
  153. used.
  154. }}}
  155. {{{  Making your own keybind
  156. {{{  general remarks
  157. To make changes in the binding files, you need to know the syntax of the
  158. OCL-commands and the keysequences the origami-terminal will send, when a
  159. key is pressed.
  160.  
  161. The OCL-commands are explained in the origami-manual; please look there !
  162.  
  163. To get the keysequences, you can use the program GetKeyCode, distributed
  164. in the amiga directory.  Start this program from cli, activate the
  165. window and press the key, which keysequence you want to know.  The
  166. keysequences will be shown in the origin CLI-window.
  167. }}}
  168.  
  169. Here are some (additional) remarks :
  170. {{{  key classes
  171. The keys, the origami-terminal will send, can be divided in five classes
  172.  {{{  mouse-clicks
  173.  * Mouse-clicks : Use the ocl function mouse-buttons !
  174.    There are 25 (!) mouse-buttons defined :
  175.    {{{  no qualifier pressed
  176.      0 : Left mouse button released, no special key pressed (LMBU)
  177.      1 : Right mouse button released, no special key pressed (RMBU)
  178.      2 : Middle mouse button released, no special key pressed (MMBU)
  179.      3 : Left mouse button pressed, no special key pressed (LMBD)
  180.      4 : Middle mouse button pressed, no special key pressed (MMBD)
  181.    }}}
  182.    {{{  shift pressed
  183.      5 : Left mouse button released, shift pressed (S-LMBU)
  184.      6 : Right mouse button released, shift pressed (S-RMBU)
  185.      7 : Middle mouse button released, shift pressed (S-MMBU)
  186.      8 : Left mouse button pressed, shift pressed (S-LMBD)
  187.      9 : Middle mouse button pressed, shift pressed (S-MMBD)
  188.    }}}
  189.    {{{  control pressed
  190.     10 : Left mouse button released, control pressed (C-LMBU)
  191.     11 : Right mouse button released, control pressed (C-RMBU)
  192.     12 : Middle mouse button released, control pressed (C-MMBU)
  193.     13 : Left mouse button pressed, control pressed (C-LMBD)
  194.     14 : Middle mouse button pressed, control pressed (C-MMBD)
  195.    }}}
  196.    {{{  alt pressed
  197.     15 : Left mouse button released, alt pressed (A-LMBU)
  198.     16 : Right mouse button released, alt pressed (A-RMBU)
  199.     17 : Middle mouse button released, alt pressed (A-MMBU)
  200.     18 : Left mouse button pressed, alt pressed (A-LMBD)
  201.     19 : Middle mouse button pressed, alt pressed (A-MMBD)
  202.    }}}
  203.    {{{  left amiga pressed
  204.     20 : Left mouse button released, left amiga pressed (L-LMBU)
  205.     21 : Right mouse button released, left amiga pressed (L-RMBU)
  206.     22 : Middle mouse button released, left amiga pressed (L-MMBU)
  207.     23 : Left mouse button pressed, left amiga pressed (L-LMBD)
  208.     24 : Middle mouse button pressed, left amiga pressed (L-MMBD)
  209.    }}}
  210.    {{{  right amiga pressed
  211.    The right amiga qualifier class is mainly used by the cut and paste
  212.    function. If origami is compiled without cut & paste you will get
  213.    these five additional buttons.
  214.     25 : Left mouse button released, right amiga pressed (R-LMBU)
  215.     26 : Right mouse button released, right amiga pressed (R-RMBU)
  216.     27 : Middle mouse button released, right amiga pressed (R-MMBU)
  217.     28 : Left mouse button pressed, right amiga pressed (R-LMBD)
  218.     29 : Middle mouse button pressed, right amiga pressed (R-MMBD)
  219.    }}}
  220.    To bind a function to one of the buttons use the keybind function
  221.    'mouse-buttons' !
  222.    Please note, that you can not bind the right mouse button pressed
  223.    events, cause they are used for the menu definition.
  224.  
  225.    {{{  Example
  226.    To bind the function open-fold to the left-mouse button released
  227.    with shift pressed, you have to add the keysequence
  228.  
  229.    ; left button release with shift pressed is button 5 (we start with 0)
  230.    (mouse-buttons  no-operation no-operation no-operation
  231.      no-operation no-operation open-fold)
  232.  
  233.    Please remember that you can use the 'mouse-buttons' function
  234.    only once in a file !
  235.    (See the doc-files in the doc directory for detailed information)
  236.    }}}
  237.  }}}
  238.  {{{  menu-select
  239.  * Menu-selections :
  240.    The keysequence will have the following format :
  241.      155 71 48+x 48+y ($csi "G "0 "0)
  242.    where x is the number of the Menu title (0,1,2,...) and
  243.          y is the number of the Menu item  (0,1,2,...).
  244.    (See the Additional Amiga Features chapter for more information)
  245.  }}}
  246.  {{{  Vanilla-Keys
  247.  * Vanilla-Keys :
  248.    All keys that are defined in the system keymap will send their
  249.    keysequences
  250.  }}}
  251.  {{{  Raw-Keys
  252.  * Raw-Keys :
  253.    All other keys will send a keysequence, that will have the following
  254.    format :
  255.      155 69 select code ($csi "E ? ?)
  256.    where select is a code used to determine the alt/amiga/ctrl and shift
  257.                 keys; it will be :
  258.                   65
  259.                   +1 if shift is pressed
  260.                   +2 if control is pressed
  261.                   +4 if alt is pressed
  262.                   +8 if left amiga is pressed
  263.                  +16 if right amiga is pressed and
  264.          code   is the number of the key.
  265.  }}}
  266.  {{{  Number-pad
  267.  * Number-pad-Keys :
  268.    The number-pad keys are handled differently :
  269.    They will have the format :
  270.      155 70 select code ($csi "F ? ?)
  271.    where select and code are the same as described in the Raw-Keys-section
  272.  }}}
  273. }}}
  274. {{{  aliases
  275. There are some aliases known to keybind :
  276. They are defined in the file amiga.alias and have to be included to be
  277. known. Look in the amiga.keys example.
  278. }}}
  279. }}}
  280. {{{  Bugs
  281. See the bug.fixes file to see the bugs of this version.
  282. }}}
  283. {{{  Compiling Origami
  284. To compile the sources you need to have the SAS C-Compiler Version 6.51.
  285. Each version will be tested with the SAS C-Compiler.  I will not test
  286. origami on other compilers, but diffs or bug reports are welcome.
  287.  
  288. If you want to compile the origami executables use the smakefiles in the
  289. amiga directory like this:
  290.  
  291.  * assign your directory containing the origami sources to the name
  292.    origami:
  293.    ( example : assign origami: Lattice:Progs/origami/src )
  294.  * Change directory to the directory 'origami:'
  295.    ( example : cd origami: )
  296.  * Start the smakefile action preinst to make the preinstallation
  297.    ( example : smake preinst )
  298.  * Start the compilation using the smakefile (action all)
  299.    ( example : smake all )
  300.  * Install the binaries in the origami:/bin directory using the
  301.    smakefile action install
  302.    ( example : smake install )
  303.  * Set the environment variables and test the executables ( see Installing
  304.    Origami )
  305.  * Clean up the directories using the smakefile action clean or reset
  306.    Note : clean will only delete .o, .lnk, .tmp and .info files.
  307.           reset will delete the binaries (not in the bin directory)
  308.                 and the things installed by using preinst.
  309.    ( example : smake clean
  310.      or :      smake reset )
  311.  * Install the binaries in your bin directory and make the .origamirc
  312.    file. You can do this using the install_origami script.
  313. }}}
  314. {{{  Features in next releases
  315. There are some features, that will be implemented in the next releases
  316.  * Future releases of the origami will be ported
  317.  * Bugs will be fixed
  318. }}}
  319. {{{  Copyrights
  320. The copyrights of the amiga version of the origami editor are
  321. identical to those mentioned in the origami manuals.
  322.  
  323. The amiga source code files are copyrighted by Thomas Hadig.
  324.  
  325. This Program is  FREEWARE  so no financial donations are required ( but
  326. welcome).  This program may be freely distributed as long as all source
  327. code, documentation and executable(s) remain unchanged and are included
  328. with the distribution.  Also no profit is to be made by selling  this
  329. program.  You may not charge more than Fred Fish does for a single
  330. library disk.  This program may be distributed on disk magazines, cover
  331. disks etc.  When you do decide to distribute this program on a disk
  332. magazine or cover disk please send me a copy of the distribution.  When
  333. you use this program on a regular base I would appreciate a postcard of
  334. your home town.
  335. }}}
  336. {{{  Acknowlegdements
  337. I want to thank some people for their help :
  338.  * Michael Sinz for his simple_rexx package
  339.  * Andreas Schneider for testing the versions
  340.  * Patrick Kandel for developing the icons and rewriting the manuals
  341.    in plain english.
  342.  * Wolfgang Stumvoll and Michael Haardt for developing the Unix and
  343.    Linux version of origami and their help finding problems.
  344. }}}
  345. {{{  Mail addresses
  346. Please use the mail address of Michael Haardt (mentioned in the origami
  347. manuals ) for reports (bugs, comments, ...) about the general origami
  348. features.
  349.  
  350. Reports on the amiga version can be mailed to Thomas Hadig :
  351. E-mail    : hadig@rog.rwth-aachen.de
  352.             hadig@pool.informatik.rwth-aachen.de
  353. Papermail : Thomas Hadig
  354.             Otzenrath
  355.             Eduard-Bauschstr. 4
  356.             D-41363 Juechen
  357. or
  358.             Thomas Hadig
  359.             Otto-Petersen-Haus Zi. 1009
  360.             Ruetscherstr. 155
  361.             D-52072 Aachen
  362. }}}
  363.